.. _cmsMxStop:

cmsMxStop
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

    VT_I4 cmsMxStop ([in] VT_I4 BoardId, [in] VT_I4 NumAxes, [in] VT_PI4 AxisList) 

DESCRIPTION
`````````````  

- 지정한 모든 축에 대한 모션을 정지(停止)합니다. cmsMxStop()  함수는 정지(停止)시에 감속 후 
  정지(停止)를 수행하며, cmsMxStopEmg() 함수는 감속없이 즉시정지(停止)를 수행합니다. 
 
\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cms 가 붙지 않습니다.

PARAMETER
`````````````

▶ BoardId: 사용자가 설정한 디바이스(보드) ID.

▶ NumAxes : 동시에 작업을 수행할 대상 축의 수

▶ AxisList : 동시에 작업을 수행할 대상 축의 배열 주소값. 이 배열의 크기는 NumAxes 값과
일치하거나 커야 합니다.
                

RETURN VALUE
`````````````

+------------+-----------+
|    Value   | Meaning   |
+============+===========+
|    음수    | 수행 실패 |
+------------+-----------+
| ERR_NONE   | 수행 성공 |
+------------+-----------+

.. note:: "윈도우 이벤트라는 것은 무엇입니까?"
    윈도우 운영체제는 Event Driven 혹은 Message Driven 방식의 구조로 되어 
    있습니다. 각 응용프로그램은 메시지 큐(Queue)를 가지고 있으며, 정확히 
    말하면, 메시지를 사용해 이벤트를 통지하는 방식으로 설계되어 있습니다. 
    윈도우 메시지를 처리한다는 것은 메시지 큐에서 메시지를 하나씩 꺼내서 
    윈도우 프로시저에 전송한다는 것을 의미하며, 이것은 그 행선지가 되는 
    윈도우에 전송되어 처리됩니다. 

EXAMPLE
`````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

    C/C++ 
    #define DEV0 0
 
    void CmsMotionDlg::OnStop()  
    { 
    long nAxes[4]={0, 1, 2, 3}; 
    GetDlgItem(IDC_btnStop)->EnableWindow(FALSE); 
    cmsMxStop(4, nAxes, TRUE, FALSE); 
    GetDlgItem(IDC_btnStop)->EnableWindow(TRUE); 
    } 

    -----------------------------------------------------------
    Visual Basic
    Const DEV0 = 0 
    Private Sub btnStop_Click()     
    Dim nRetVal As Long 
    Dim AxisList(2) As Long 
    AxisList(0) = 0 
    AxisList(1) = 1 
    ' 각 인자에 대한 설명을 드립니다. 
    ' MxStop( 디바이스 ID, 축 갯수, 배열, 완료대기여부, 블록여부) 
    ' 0. 디바이스 ID 
    ' 제어하고자 하는 디바이스의 ID입니다. 
    ' 1. 축 갯수 
    ' 다축제어에서 배열 요소에 해당하는 대상 축의 갯수입니다. 
    ' 2. 배열 
    ' 축 배열을 전달합니다. 이 배열 내부의 축은 X, Y, Z, U 축을 기본으로  
    하지만 사용자가 원하는 축의 조합 (예 : X1, Y2, U1, Z1) 등의 조합의  
    배열로도 전달 할 수 있습니다. 
    ' 단 '1. 축 갯수'는 대상 축의 총 갯수입니다 
    nRetVal = MxStop(DEV0, 2, AxisList(0))    
    End Sub

    -----------------------------------------------------------

    Delphi
     
    // * Description : 
    // * 이 함수는 버튼 이벤트에 의해 모션 동작을 정지(停止)하는 함수입니다. 
    // * 
    procedure btnStopClick(); 
    var 
    AxisList : Array[0..1] of LongInt; 
    gnTargetAxis : LongInt; 
    begin 
    AxisList[0] := 0; 
    AxisList[1] := cmsY1; 
    gnTargetAxis := 2; 
    // 정지(停止) 함수의 원형은 cmsSxStop([Device ID], [TargetAxis]) 입니다. 
    // TargetAxis : 정지(停止) 할 대상 축을 설정합니다. 
    cmsMxStop(0, gnTargetAxis, @AxisList); 
    end; 
    -----------------------------------------------------------